Skip to main content

Get a client detail

GET /api/v1/Clients/:ClientId

Description​

This endpoint is used to retrieve information about a specific client.

Request​

Headers

  • None

ApiKey

No API key required

Content-Type​

  • text/plain

  • application/json

  • text/json

Query Parameters​

  • ClientId: integer, required

  • version: string, required

Request Body​

No request body is required

URL​

{{baseUrl API url}}/api/v{version}/Clients/{ClientId}

Response​

A JSON object containing information about the specified client.

Error Codes​

  • 400: Bad Request

  • 404: Resource not found

  • 500: Internal server error

Example​

Plain Text​

GET /api/v1/Clients/12345?PageNumber=1&PageSize=10

Response​

perlCopy codeHTTP/1.1 200 OK
{
  "ClientId": 12345,
  "Name": "John Doe",
  "Email": "john.doe@example.com",
  "Phone": "123-456-7890",
  "Address": {
    "Street": "123 Main St",
    "City": "Anytown",
    "State": "CA",
    "Zip": "12345"
  }
}
/api/v`{{version}}`/Clients/:ClientId

Headers​

Content-TypeValue
Accept-Language

Response: 200​

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/Clients/:ClientId \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!